Skip to content

Docs refresh and Apache 2.0 license#28

Merged
siphonite merged 3 commits intomainfrom
issue-18-reentrant-docs
Feb 7, 2026
Merged

Docs refresh and Apache 2.0 license#28
siphonite merged 3 commits intomainfrom
issue-18-reentrant-docs

Conversation

@siphonite
Copy link
Owner

Summary

Refresh project documentation for v0.1 release readiness.

Changes

  • README: Complete rewrite - concise, professionally formatted
  • LICENSE: Switch from MIT to Apache 2.0
  • Logo: Updated project logo
  • Docs: Rewrote all architecture docs and limitations for conciseness (~60% reduction)
    • 001_structure.md
    • 002_crash_point.md
    • 004_orchestrator.md
    • limitations.md
    • proof/reference_wal.md
  • Cleanup: Removed empty invariants.md

Milestone

Part of v0.1 – Docs & Release

Closes #27

Add Integration Constraints section to limitations.md:
- One first::test() per #[test]
- Async tests not supported
- Not thread-safe
- No nested workspaces

Add limitations summary to lib.rs crate docs.

Closes #18
- Rewrite README for conciseness and professional formatting
- Switch license from MIT to Apache 2.0
- Update project logo
- Rewrite all architecture docs (~60% reduction)
- Rewrite limitations.md and proof/reference_wal.md
- Remove empty invariants.md
@siphonite siphonite merged commit 2657a1d into main Feb 7, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs refresh and Apache 2.0 license

1 participant